Reads the alias address from an EtherCAT slave.
Namespace: IntervalZero.KINGSTAR.Local.Api
Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0
Syntax
public KsCommandStatus<ushort> ReadSlaveAlias(
int SlaveId
)Public Function ReadSlaveAlias(
SlaveId As Integer
) As KsCommandStatus(Of UShort)Parameters
SlaveId
Type: int
The index of a slave array. When EtherCAT is started, this index has the same value as the SlaveId, which corresponds to the position of the slave in the network. Please note that after EtherCAT is started in the Operational (Op) state, any addition or removal of slaves from the network will change the position of the slaves in the network (SlaveId). Nevertheless, the index of the slave will remain the same. Newly added devices will be added in the back of the slave array. For all slaves after the change, the index and SlaveId will no longer match. This behavior is only available for physical devices; simulated devices are inapplicable. Please refer to the use cases in EnableHotConnect for more details.
Return value
Type: KsCommandStatus<ushort>
Returns the KsCommandStatus class and an unsigned short integer value.
Usable EtherCAT states
ecatInit, ecatPreOP, ecatSafeOP, ecatOP
Examples
N/A
See also